Node / meshtastic / Meshtastic-Android / files / core / repository / src / commonMain / kotlin / org / meshtastic / core / repository / NodeController.kt

Displaying Raw • Download

T8b949e/*

* Copyright (c) 2026 Meshtastic LLC

*

* This program is free software: you can redistribute it and/or modify

* it under the terms of the GNU General Public License as published by

* the Free Software Foundation, either version 3 of the License, or

* (at your option) any later version.

*

* This program is distributed in the hope that it will be useful,

* but WITHOUT ANY WARRANTY; without even the implied warranty of

* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the

* GNU General Public License for more details.

*

* You should have received a copy of the GNU General Public License

* along with this program. If not, see <https://www.gnu.org/licenses/>.

*/

Tff7b72package T7ee787org.meshtastic.core.repository

T8b949e/**

* Node management operations — favorite, ignore, mute, and remove nodes.

*

* Mirrors the node management subset of the SDK's `AdminApi` (setFavorite, setIgnored, toggleMuted). When the SDK is

* adopted, implementations delegate to `RadioClient.admin.setFavorite(NodeId, Boolean)` etc.

*

* @see RadioController which extends this interface for backward compatibility

*/

Tff7b72interface T56d364NodeController Tb4b4b4{

T8b949e/**

* Sets the favorite status of a node on the radio.

*

* Idempotent: a no-op if the node is already in the requested state. Mirrors the SDK's `setFavorite(NodeId,

* Boolean)` — an explicit target state rather than a toggle, so concurrent callers can't race a read-modify-write.

*/

Tff7b72suspend Tff7b72fun Td2a8ffsetFavoriteTb4b4b4(Te6edf3nodeNumTb4b4b4: Tffa657IntTb4b4b4, Te6edf3favoriteTb4b4b4: Tffa657BooleanTb4b4b4)

T8b949e/**

* Sets the ignore status of a node on the radio.

*

* Idempotent, like [setFavorite]. Mirrors the SDK's `setIgnored(NodeId, Boolean)`.

*/

Tff7b72suspend Tff7b72fun Td2a8ffsetIgnoredTb4b4b4(Te6edf3nodeNumTb4b4b4: Tffa657IntTb4b4b4, Te6edf3ignoredTb4b4b4: Tffa657BooleanTb4b4b4)

T8b949e/** Toggles the mute status of a node on the radio. Mirrors the SDK's `toggleMuted(NodeId)`. */

Tff7b72suspend Tff7b72fun Td2a8fftoggleMutedTb4b4b4(Te6edf3nodeNumTb4b4b4: Tffa657IntTb4b4b4)

T8b949e/** Removes a node from the mesh by its node number. */

Tff7b72suspend Tff7b72fun Td2a8ffremoveByNodenumTb4b4b4(Te6edf3packetIdTb4b4b4: Tffa657IntTb4b4b4, Te6edf3nodeNumTb4b4b4: Tffa657IntTb4b4b4)

Tb4b4b4}